home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr33 / 4cat120.zip / 4CAT120.DOC < prev    next >
Text File  |  1993-05-30  |  24KB  |  548 lines
  1.      
  2.  
  3.  
  4.                                                                         |
  5.                                                                         |
  6.                                                                         |
  7.                                                                         |
  8.                                                                         |
  9.                                                                         |
  10.                                                                         |
  11.                                                                  4Cat   |
  12.                                                                         |
  13.                                                                         |
  14.                                                          Version 1.20   |
  15.                                                 Released May 30, 1993   |
  16.                                                                         |
  17.                                                                         |
  18.                                                   by Earl R. Davidson   |
  19.                                                                         |
  20.                                                                         |
  21.                                                                         |
  22.                                                                         |
  23.                                                                         |
  24.                                                                         |
  25.                                                                         |
  26.                    Program and Documentation Copyright (c) 1991, 1993   |
  27.                                                   by Earl R. Davidson   |
  28.                                            2908 West Doublegate Drive   |
  29.                                                      Albany, GA 31707   |
  30.                                                   All rights reserved   |
  31.                                                                         |
  32.                                                                         |
  33.                                                                         |
  34.                                                                         |
  35.                                                                         |
  36.                                                                         |
  37.                                                                         |
  38.                Portions Copyright (c) 1989 - 91 Microsoft Corporation   |
  39.         Portions Copyright (c) 1988 - 91 Ethan Winer, Donald R. Malin   |
  40.                                                 and Crescent Software   |
  41.                                                                         |
  42.                                                                         |
  43.                                                                         |
  44.                                                                         |
  45.                                                                         |
  46.                                                                         |
  47.                                                                         |
  48.                                 4DOS is a trademark of J. P. Software   |
  49.                              PC-DOS is a trademark of IBM Corporation   |
  50.                        MS-DOS is a trademark of Microsoft Corporation   |
  51.                                                                         |
  52.                                                                         |
  53.                                                                         |
  54.                                                                         |
  55.                                                                         |
  56.  
  57.                                    Notice
  58.  
  59.            This program is not in the public domain.  You are hereby
  60.            granted a limited right to copy the program and pass it on to
  61.            friends and upload it to any bulletin board system, provided
  62.            no fee is charged other than a nominal disk fee.  You may use
  63.            the program for up to twenty one (21) days without
  64.            registering it.  If you use it for more than this, please
  65.            register.  Site licenses are available for corporate use. 
  66.            Contact the author for more information.
  67.  
  68.  
  69.  
  70.                                Acknowledgments
  71.  
  72.            This program was written using the Microsoft Basic 7.1
  73.            Professional Development System and the Crescent Software
  74.            QuickPak Professional Advanced Programming Library (Version
  75.            4.01).  4DOS (Version 4.0) by J. P. Software, was also being
  76.            used, and, in fact, provided the inspiration for this
  77.            program.  I thank all three companies for making these
  78.            outstanding products available. 
  79.  
  80.  
  81.  
  82.                                  Disclaimer
  83.  
  84.            4Cat is distributed without warranty, expressed or implied,
  85.            including without limitation the warranties of merchanta-
  86.            bility and of fitness for a particular purpose.  You, the
  87.            user, assume full responsibility for the selection and use of
  88.            4Cat to achieve your desired results.
  89.  
  90.  
  91.  
  92.                                 Introduction
  93.  
  94.            4Cat is a file cataloging program for disks.  It allows you
  95.            to quickly build or add to a database of your disk files and
  96.            to search this database quickly to locate a particular file. 
  97.            4Cat also tracks the free disk space on each disk cataloged. 
  98.            This allows you to find a disk with just enough space to
  99.            store a particular file.  Disks are identified and cataloged
  100.            based on their volume label.  Users of 4DOS will have their
  101.            file descriptions added automatically.  These descriptions
  102.            are included in the searches.
  103.  
  104.            That's all I wanted a catalog program to do, so 4Cat does not
  105.            print disk labels, require the entry of complicated
  106.            categories, or make you confirm numerous choices for each
  107.            disk.  There are no complicated setup steps and no menus to
  108.            wade through.  
  109.  
  110.            4Cat - Version 1.20                                     Page 1
  111.  
  112.            4Cat includes directory names in the database as if they were
  113.            a file name.  The 4DOS description, if any, is shortened to
  114.            34 characters and "<DIR> " inserted at the beginning of the
  115.            description.  If you save your files in directories on your
  116.            disks this will allow you to search the database for a
  117.            directory name.  Note that the files stored in the
  118.            directories are NOT included in the 4Cat database.  Only the
  119.            files and directories in the root of the disk are included.
  120.  
  121.  
  122.  
  123.                                 Installation
  124.  
  125.            COPY the 4CAT.EXE file to a directory that is in your normal
  126.            PATH command.  If you have a utility directory that your
  127.            store various programs in, that would be ideal.  That's it! 
  128.            The first time you run 4Cat, it will create a database file
  129.            named 4CAT-DB.MDB in the same directory in which 4CAT.EXE is
  130.            located.
  131.  
  132.  
  133.                         Adding Files to the Database
  134.  
  135.            4Cat is invoked from the DOS command line.  There are no
  136.            menus.  There are basically two modes of operation - (1)
  137.            adding files to the database and (2) searching the database
  138.            for a particular file.  Let's look at adding records of files
  139.            first.  The format for calling 4CAT is:
  140.  
  141.                4CAT [/d:] [/n]
  142.  
  143.            where /d: is an optional valid drive designation and /n is an
  144.            optional parameter explained below.  Here are a few command
  145.            line examples:
  146.  
  147.                4CAT                Adds the files on the disk in drive
  148.                                    A: (the default) to the database.
  149.  
  150.                4CAT /b:            Adds the files on the disk in drive
  151.                                    B: to the database.
  152.  
  153.                4CAT /n             Adds the files on the disk in drive
  154.                                    A: and does not stop when the display
  155.                                    of those files fills the screen.
  156.  
  157.            When 4Cat is invoked to add files it first reads the current
  158.            volume label for the disk and allows you to edit or change
  159.            it.  You should consider a numbering system for your disks. 
  160.            Mine is simple - I started with 1 (one) and went up.  If you
  161.            change the volume label it will be written back to the disk. 
  162.            This is the ONLY time 4Cat writes to a disk, other than to
  163.            the 4CAT-DB.MDB file.  The filenames and directory names are
  164.            
  165.            4Cat - Version 1.20                                     Page 2
  166.  
  167.            then read, added to the database and displayed on your
  168.            monitor.  The last entry displayed is the free space on the
  169.            disk.  
  170.  
  171.            After the records are added, you are returned to the DOS
  172.            prompt.  Continue cataloging files in this manner.  Note that
  173.            only one set of records will be maintained for each volume
  174.            label.  If you try to add a second disk with a volume label
  175.            that is already cataloged, the existing records will be
  176.            removed from the database before the new ones are added. 
  177.  
  178.            To remove records for an entire disk from the database,
  179.            insert a disk with no files on it, execute 4Cat, and enter
  180.            the volume label for the disk you want to delete.  The
  181.            records will be removed and a "No files found" message
  182.            displayed.
  183.  
  184.            That's all there is to cataloging your files.  One simple
  185.            command at the DOS prompt and it's done.
  186.  
  187.  
  188.                            Searching the Database
  189.  
  190.            To search for a file just invoke 4CAT with a search "string"
  191.            at the DOS prompt, where "string" is a word, filename, or
  192.            portion thereof that you wish to find.  4Cat will search the
  193.            filenames, and 4DOS descriptions, in your database.  If your
  194.            "string" is detected, the file information, and 4DOS
  195.            description, will be displayed.  The "string" will be
  196.            highlighted on the display.  If more matches are found than
  197.            will fit on one screen, 4Cat pauses and waits for you to
  198.            press a key.  This method of searching and displaying the
  199.            results is similar to the locate or search function found on
  200.            many BBS programs.
  201.  
  202.            The DOS wildcards (* and ?) are not needed or supported. 
  203.            4Cat will find your "string" anywhere in the filename or 4DOS
  204.            description. 
  205.  
  206.            The format for calling 4Cat in search mode is:
  207.  
  208.                4CAT [/n] string
  209.  
  210.            Here are some examples of searching a 4Cat database:
  211.  
  212.                4CAT basic          Will find all records with the word
  213.                                    "basic" in the filename, directory
  214.                                    name, or description.
  215.  
  216.                4CAT basic /n       Same as above, but the display of
  217.                                    matching records does not stop when
  218.                                    the screen is full.
  219.  
  220.            4Cat - Version 1.20                                     Page 3
  221.  
  222.                4CAT .              4Cat will display ALL filename and
  223.                                    directory records in the database
  224.                                    because they all have a period (.)
  225.                                    between the filename and the
  226.                                    extension.
  227.  
  228.  
  229.  
  230.                             Command Line Options
  231.  
  232.              Option:   /v:string
  233.             Meaning:   Search the volume name for "string"
  234.            Comments:   This allows you to search the disk volume label
  235.                        names for your "string."
  236.             Example:   4CAT /v:127     Search for all records whose
  237.                                        volume label contains the string
  238.                                        "127".
  239.  
  240.  
  241.              Option:   /?
  242.             Meaning:   Display the help screen.
  243.            Comments:   The "/" is optional.  Either "/?" or "?" on the
  244.                        command line will display the help screen.  This
  245.                        means that you cannot search your data base for a
  246.                        question mark only.
  247.  
  248.  
  249.              Option:   /n
  250.             Meaning:   Non-stop display.
  251.            Comments:   Adding the /n option to the command will cause
  252.                        4Cat to not stop when the screen if filled. 
  253.                        Instead of pausing with the "press any key"
  254.                        prompt, the screen is cleared and more files
  255.                        listed, until the last screen.  This is most
  256.                        useful when redirecting output to a file as
  257.                        explained below.
  258.  
  259.  
  260.              Option:   /f
  261.             Meaning:   Display the free disk space available on each
  262.                        disk.
  263.            Comments:   The display sorted in order of disk space.  This
  264.                        option allows you to find a disk with just enough
  265.                        space to store a file.  Utilizing this can help
  266.                        you get maximum efficiency from your disks.  You
  267.                        may enter a number representing a minimum amount
  268.                        of disk space that you need and 4Cat will begin
  269.                        its display with the first disk that has that
  270.                        much space available.  This keeps you from
  271.                        having to page through numerous screens of disks
  272.                        with too little space available.
  273.  
  274.  
  275.            4Cat - Version 1.20                                     Page 4
  276.  
  277.            Examples:   4CAT /f                 Displays all disks and
  278.                                                space available.
  279.  
  280.                        4CAT /free              Same as above.  Retained
  281.                                                for compatiblity with
  282.                                                version 1.00.
  283.  
  284.                        4CAT /f9000             Displays all disks with
  285.                                                at least 9000 bytes of
  286.                                                free space.
  287.  
  288.                        4CAT /f9k               "K" or "k" multiplies
  289.                                                number entered by 1,000.
  290.  
  291.                        4CAT /f1m               "M" or "m" multiplies
  292.                                                number entered by
  293.                                                1,000,000 bytes.
  294.  
  295.  
  296.              Option:   >
  297.             Meaning:   DOS redirection of output.
  298.            Comments:   This is not really an option of 4Cat.  It is the
  299.                        use of DOS's redirection capability.  4Cat does
  300.                        not provide for the direct printing of your
  301.                        database; however, you may use the DOS
  302.                        redirection command to direct the listing to a
  303.                        disk file.  The output file will be a clean,
  304.                        ASCII file, with no headers, footers, or page
  305.                        breaks.  You may then load this file into your
  306.                        favorite editor or word processor and print it. 
  307.                        The following commands will output all or a
  308.                        portion of your database to a file named
  309.                        TEXT.TXT:
  310.  
  311.            Examples:   4CAT . > TEST.TXT       List all records to the
  312.                                                file.
  313.  
  314.                        4CAT /n . > TEST.TXT    List all records in "non-
  315.                                                stop" mode to the file.
  316.  
  317.                        4CAT string > TEXT.TXT  List only those records
  318.                                                that match "string" to
  319.                                                the file.
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.            4Cat - Version 1.20                                     Page 5
  331.  
  332.                               Database Utilities
  333.                     (included with registered version only)
  334.  
  335.            Users who register 4Cat will be sent a diskette containing   |
  336.            the latest version of 4Cat and two database utilities:       |
  337.                                                                         |
  338.            Repair:     Helps recover databases that have become         |
  339.                        corrupted due to power outages, etc.             |
  340.                                                                         |
  341.            Pack:       Packs the database file by removing records      |
  342.                        marked for deletion and shrink the file (in      |
  343.                        32K increments.  Also rebuilds the indexes.      |
  344.                                                                         |
  345.            Currently registered users who wish to receive the disk with |
  346.            these two utilities should send in the registration form     |
  347.            with their current address and note the version number       |
  348.            registered and the approximate date of registration          |
  349.  
  350.  
  351.  
  352.  
  353.                               4DOS Descriptions
  354.  
  355.            4Cat utilizes the descriptions available with 4DOS.  If the
  356.            DESCRIPT.ION file exists on the disk being cataloged, the
  357.            descriptions will be added to the database.  While 4Cat does
  358.            not allow you to edit these descriptions, it is easy enough
  359.            to do using one of the fine editors already available.  4Edit
  360.            and FDU (File Description Utility), are two description
  361.            editors that I am aware of.  Simply add one of the following
  362.            to your 4DOS Aliases file:
  363.                e4    fdu a: ^ 4cat             e4    4edit a: ^ 4cat
  364.                e4b   fdu b: ^ 4cat b:          e4b   4edit b: ^ 4cat b:
  365.            This will allow you to edit the descriptions using your
  366.            favorite editor, then automatically catalog the disk.
  367.  
  368.            Non 4DOS users may be able to use one of these editors
  369.            without using 4DOS.  Try a batch file similar to this to
  370.            create/edit a DESCRIPT.ION file and then have 4Cat use it:
  371.                FDU A:
  372.                4CAT
  373.  
  374.            4DOS version 4.0 extended descriptions are recognized but not
  375.            displayed.  If the available editors are updated to allow the
  376.            input of the extended descriptions (up to 4096 characters per
  377.            file) and if the registrations of 4Cat warrant, a later
  378.            version of 4Cat may add that capability.
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.            4Cat - Version 1.20                                     Page 6
  386.  
  387.                                Release History
  388.  
  389.            Version  1.20 - Released May 30, 1993.                       |
  390.                o       Inclusion of database repair and packing         |
  391.                        with registered version.                         |
  392.                                                                         |
  393.                o       Minor cosmetic changes.                          |
  394.  
  395.            Version  1.10 - Released December 14, 1991.
  396.                o       Additional options added to /f switch allowing
  397.                        the search for free disk space to begin at a
  398.                        minimum amount as specified on the command line.
  399.  
  400.                o       The "-" and "_" caracters are no longer valid
  401.                        command line separators.  This allows them to be
  402.                        used in search strings.
  403.  
  404.                o       Fixed problem of not locating description for
  405.                        files with no filename extention and a filename
  406.                        of less than eight (8) characters.
  407.  
  408.                o       Fixed a couple of minor screen display errors.
  409.  
  410.            Version 1.00 - Released December 2, 1991.
  411.  
  412.  
  413.                                 Registration
  414.  
  415.            To register this program for permanent use, complete the form
  416.            on the next page and mail, together with your check for
  417.            $10.00, to the address on the form.  Registering now will
  418.            entitle you to use the current version of 4Cat and all minor
  419.            update and bug-fix releases through the next major release
  420.            number.
  421.  
  422.            For example:  If you are registering version 1.20:
  423.                                                         ^ ^^
  424.                The major version number is 1 -----------| ||
  425.                The minor version number is 1 -------------||
  426.                The bug-fix version number is 0 ------------|
  427.  
  428.            you may use the program at least through version 2.99 without
  429.            re-registering or paying any additional fee.
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.            4Cat - Version 1.20                                     Page 7
  441.  
  442.                                    Support
  443.  
  444.            I will provide limited free (but not toll free) telephone
  445.            support to those people who have registered their copy of
  446.            4Cat.  I may generally be reached between the evening hours
  447.            of 7:00 pm and 10:00 pm Eastern time, or Saturday from 10:00
  448.            am to 10:00 pm.  As you might guess from these hours, I do
  449.            not write programs or provide free support for a living.  You
  450.            may reach me at (912) 432-2479.  Please observe the above
  451.            hours and do not call collect.  Please have your version
  452.            number available when you call.
  453.  
  454.            I may also be reached on CompuServe:  72203,1235.
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.            4Cat - Version 1.20                                     Page 8
  496.  
  497.  
  498.                            4Cat Registration Form
  499.  
  500.  
  501.            Your Name: _______________________________  Date: __________
  502.  
  503.            Company:   _______________________________ 
  504.  
  505.            Address:   _______________________________ 
  506.  
  507.                       _______________________________ 
  508.  
  509.            City, St:  _______________________________  Zip: ___________
  510.  
  511.            Do you wish to receive the database utilities disk? ________
  512.  
  513.            If yes, indicate disk size:  5.25 _____   or 3.5 _____
  514.  
  515.                                         DD   _____   or  HD _____
  516.  
  517.            4Cat version number: _______________________
  518.  
  519.            Where did you obtain your copy of 4Cat?
  520.  
  521.            _____________________________________________________________
  522.  
  523.            _____________________________________________________________
  524.  
  525.            Suggestions:
  526.            _____________________________________________________________
  527.  
  528.            _____________________________________________________________
  529.  
  530.            _____________________________________________________________
  531.  
  532.            _____________________________________________________________
  533.  
  534.            _____________________________________________________________
  535.  
  536.            _____________________________________________________________
  537.  
  538.            _____________________________________________________________
  539.  
  540.  
  541.                                    Mail to:    Earl R. Davidson
  542.                                                2908 W. Doublegate Drive
  543.                                                Albany, GA 31707
  544.  
  545.            Please include your check or money order for $10.00 (US). 
  546.  
  547.            Thank you for using 4Cat, and thanks for registering.       
  548.